home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / util / cdity / filefind.lha / File Finder.doc < prev    next >
Encoding:
Text File  |  1995-02-21  |  11.8 KB  |  393 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                                    01108730-0
  7.  
  8.  
  9.                                                     Version
  10.                                                       1.0
  11.  
  12.  
  13.  
  14.  
  15.                                                   Mark Melton
  16.  
  17.  
  18.  
  19.                                                      ©1995
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                                           Generated with Heddley v1.1
  37.                                        Heddley v1.1 (C) Edd Dumbill 1994
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.                                                    - Page 1 -
  77.  
  78.  
  79.  
  80. 1.    File Finder
  81.  
  82.                                      File Finder 
  83.                          Release Version 1.05 2nd Feb 1995 
  84.                              written by Mark Melton 
  85.                email u9326383@radon.sys.uea.ac.uk (until July 96)
  86.  
  87.  
  88. Contents 
  89.  Copyright 
  90.  Introduction 
  91.  Requirements 
  92.  Installation 
  93.  Usage 
  94.  Problems
  95.  Future plans 
  96.  Acknowledgements 
  97.  Suggestions/Registration
  98.  
  99. 2.    Copyright
  100.  
  101.                                          Copyright
  102.  
  103. This product may be freely distributed as long as certain conditions are met.
  104.  
  105. 1. This product may only be distributed in a compleat form this doc file including copyright message  must be  i
  106. ncluded .
  107.  
  108. 2. This product may be freely distributed via the internet or any other non commercial venture.  
  109.  
  110. 3. This program my only be distributed by a commercial PD library only with my express
  111. permission, for  which a charge will be made.
  112.  
  113. 4. No charge may be made for the distribution of this product except for a nominal fee
  114. for the media on which it is transmitted, without my permission.
  115.  
  116. 5. This product may not be included on any magazine coverdisk without my written consent
  117. except for the Amiga Shopper magazine based in the UK.
  118.  
  119. 6. This product will not be included in any commercial package, unless my written consent
  120. is obtained before distribution.
  121.  
  122. By distributing, using or copying the product you indicate your acceptance of the above conditions.
  123.  
  124. Disclaimer
  125.  
  126. This program is provided as is, and no liability is accepted for any dammage caused to you, your  machine,  or f
  127. or that matter anything else. Hey if using this program causes WW3 don't blame me OK.
  128.  
  129. 3.    Introduction
  130.  
  131. Introduction
  132.  
  133. This program is used for finding things, still you probably worked that out from the name ;-). I wrote it mainly
  134. because I have access to several Amigas (TM), with rather large hard-drive's.
  135. I found there was a need to quickly  find the location of file's on the machines as many of them have files
  136. stored in different ways. There was also the article in the Amiga Shopper magazine on a file finding utility.
  137. I modified their code a bit and added substantial amounts, and came up with this program.
  138.  
  139.  
  140. Current features in version 1.07
  141.  
  142. Find any file on a disk, using standard AmigaDos(TM) file matching patterns.
  143.  
  144. Fully implemented as a commodity, with user definable hotkey etc.
  145.  
  146.  
  147.                                                    - Page 2 -
  148. 3.    Introduction
  149.  
  150. Limit search size parameters, only files in a certain size range are checked.
  151.  
  152. Limit date range parameters, only files in a ceratain date range are checked.
  153.  
  154.  + a few bug fixes ;->
  155.  
  156.  Stack overflow fixed. Reported by millions (well at least four people :-) 
  157.  GUI problems when running on non-interlaced NTSC machines fixed.  Reported by a NTSC A500 user, thanks!
  158.  
  159. 4.    Requirements
  160.  
  161. Requirements for File Finder.
  162.  
  163. It is essential that you have at least kickstart & Workbench 2.04.
  164.  
  165. Other than that there are no further restrictions, well appart from having an amiga :-).
  166.  
  167. The program has been written on an A1200 with 50MhzGVP A1230-II. It ha  been tested using enforcer and causes no
  168. enforcer hits so it should be OK on all amigas.
  169.  
  170. Tested on plain A1200, A4000/040, A4000/030/ and an A3000.  I would be grateful
  171. for people to confirm its operation on other machines, e.g. A500+, A2000, etc.
  172.  
  173. 5.    Usage
  174.  
  175. Usage
  176.  
  177. This program was designed with one goal in mind, to be simple to use. It is for this reason that the standard "l
  178. ook"  of the workb ench has been  used. The program has three main interface area's. The file list at the top (i
  179. nitialy blank ), the search paameter control's, contained within the "raised" box, and the program  control
  180. functions at  the bottom. A screen shot of this is included and can be viewed by pressingthis button in WB3.0 or
  181.  above, or by using the display utility in the  utilities drawer.
  182.  
  183. Firstly the Search parameter gadgets will be described.  
  184.  
  185. The status gadget informs the user of the current status of the program. It is not selectable by the user.
  186.  
  187. The Path gadget, keyboard shortcut P, is used to specify the drive or directory in
  188. which to look for the file. Limiting the search to a particular directory saves
  189. time by reducing the number of files which have to be searched. e.g.
  190.  
  191. DH0:
  192.  
  193. This would search all of DH0:,  whereas
  194.  
  195. DH0:Utilities/
  196.  
  197. would only search the directory dh0:utilities.
  198.  
  199.  
  200. The Pattern gadget, keyboard shortcut T, is used to specify the file for which to
  201. search. Standard AmigaDOS file patterns are accept ed, to save you digging out your AmigaDOS manual, if you even
  202.  have one, here are the pattern's
  203.  
  204.  ?               Matches any single character.
  205.  
  206.  #<p>            Matches zero or more occurances of <p>.
  207.  
  208.  <p1>|<p2>       Matches if either <p1> or <p2> matches.
  209.  
  210.  -<p>            Matches everything but <p>.
  211.  
  212.  (<p1><p2>...)   Groups items together.
  213.  
  214.  %               Matches the null string.
  215.  
  216.  [<p>-<p>]       Determines a character range.
  217.  
  218.                                                    - Page 3 -
  219. 5.    Usage
  220.  
  221.  
  222. Now unless you've used AmigaDOS extensivly, that lot will be about as clear as mud. So here's the english transl
  223. ation.
  224.  
  225.  A?B             Matches any three letter word begining in A and ending in B. Such as AcB, AzB, ABB, etc.
  226.  
  227.  A#BC Matches any name beginning in A and ending in C, with any number of B's in
  228. between. Such as ABC, ABBC, ABBB  C, etc.
  229.  
  230.  ABC#?           Matches any name beginning ABC. Such as ABCD, ABCPIC.info, etc.
  231.  
  232.  #?XYZ           Matches any name ending XYZ. Such as MARK_XYZ, PICXYZ, etc.
  233.  
  234.  ABC#?XYZ        Matches any name beginning ABC and ending XYZ. Such as ABCXYZ,  ABCMARKXYZ, etc.
  235.  
  236.  A(B|C)D         Matches ABD or ACD.
  237.  
  238.  ~(XYZ)          Matches anything but XYZ.
  239.  
  240.  ~(#?.info)      Matches anything not ending in .info.
  241.  
  242.  A#(BC) Matches any name begining with A followed by any number of BC's. Such as ABC, ABCBC, ABCBCBC, etc.
  243.  
  244.  A(B|D|%)C Matches any name starting with A ending with C with B, D or nothing in
  245. between. Such as ABC, ADC or AC  .
  246.  
  247.  [A-D]#?         Matches any name beginning with A, B, C or D.
  248.  
  249.  
  250.  
  251. The Size button, keyboard shortcut S, opens the Search Size limit window containing three gadgets. They are the
  252. info gadget, which is a small reminder of what to do, the Max Size gadget,
  253. keyboard shortcut M, where the  maximum file size to include in the search is put, and the M in Size gadget,
  254. keyboard shortcut S, where the  minimum file size to inculde in the search is put. The search size limit window
  255. does not have to be closed after use and can be left open. To ignore a maximum file size limit enter a value of
  256. 0. e.g.
  257.  
  258. Max size = 0 Min size = 1000
  259.  
  260. would only look for files over 1000 bytes (1Kb) in size. 
  261.  
  262. Max size = 10000 Min size = 5000
  263.  
  264. would only look for files over 5000 bytes (5Kb) long but under 10000 bytes (10 Kb).
  265.  
  266.  
  267. The Date button, keyboard shortcut D, opens the Date Size limit window containing three dadgets.  They are the
  268. info gadget, which is a small reminder of what to do, the From gadget, keyboard shortcut F, where the earliest
  269. date to include in the search is entered, and the To gadget, keyboard shortcut T, where the most recent date to
  270. include is entered.  The date range limit window does not have to be closed after use and can be left open.  To
  271. ignore a date limit leave the gadget empty.
  272.  
  273. The date should be entered in a DD-MMM-YY format e.g.
  274.  04-Mar-95, also 04-03-95 works equally well.
  275.  
  276.  
  277. The List Gadget.
  278.  
  279. This is where the list of files that match the search parameters will appear. If the list gadget is clicked on, 
  280. details of the file selected, will appear in the info
  281. window. This provides details such as the creation date of the file, its name, the path to the file and its
  282. size. The info window can be left open when selecting other files, there details will replace those already
  283. in the info window. 
  284.  
  285.  Program control gadgets.
  286.  
  287. Quit, keyboard shortcut Q, exits the program immediatly. Warning, you will not be asked to confirm a quit reques
  288.  
  289.                                                    - Page 4 -
  290. 5.    Usage
  291.  
  292. t.
  293.  
  294. Find, keyboard shortcut F, commences the search with the current search parameters.
  295.  
  296. Abort, keyboard shortcut A, aborts the current search operation. This will stop the search at the point it had r
  297. eached  when the  abort button was pressed. Search
  298. operations must be allowed to compleat or aborted before any other commands can be used, such as Quit.
  299.  
  300. Print, keyboard shortcut R, print's the current contents of the list to the current prefs printer.
  301.  
  302. 6.    Installation
  303.  
  304. Installation
  305.  
  306. This couldn't possibly be easier.  Simply drag the File Finder icon to wherever you want
  307. it to be put. I would recomend either your utilities drawer, tools drawer or preferbly your WBStartup drawer.
  308.  
  309.  
  310. The documentation consists of the AmigaGuide format doc, and a plain text file.  Also there is also a picture of
  311. the interface this should ideally be kept in the same place as the amigaguide doc.
  312.  
  313. New to version 1.05.
  314.  
  315. TOOLTYPES
  316.  
  317. (See page 10-23 of the WorkBench 3.0 manual.)
  318.  
  319. CX_HOTKEY="ctrl F" or any other combination you want.  This key combination will cause
  320. the program to popup its GUI(Graphical user interface) if it is currently "Hidden".
  321.  
  322. Use the tooltype  DONOTWAIT if you run the program from the WBStartup drawer.
  323.  
  324. The  CX_POPUP tooltype determinew if the program opens its GUI on startup.
  325.  
  326. 7.    Problems
  327.  
  328. Problems
  329.  
  330. One problem that you might experience if you have a particularly deep directory structure, is that of
  331. a stack overflow.  This can be solved by the increasing the stack size of the  program.  See page 3-19 of the
  332. WB3.0 manual for details on how to do this.  
  333.  
  334. If you discover any problems with this program send me
  335. the details, such as what the problem is, what sort of machine you use machine, you KS and WB
  336. version numbers and an address where you can be contacted.
  337.  
  338. 8.    Future plans
  339.  
  340. Future plans
  341.  
  342. Immplement the type limit feature.  This my take a while :-(
  343.  
  344. You never know, some shareware subscriptions might encorage me to get these features implemented :->
  345.  
  346. Also I would welcome any suggestions for improvements or new features.
  347.  
  348. Contacts
  349.  
  350. 9.    Acknowledgements
  351.  
  352. Acknowledgements
  353.  
  354. Thanks go to the Amiga Shopper magazine in the UK for providing the inspiration for this
  355. program. This program is loosly based on a program that they ran as a C programming
  356. tutorial, but has had considreable enhancements, and extra features added.
  357.  
  358.  
  359.  
  360.                                                    - Page 5 -
  361. 9.    Suggestions/Registration
  362.  
  363.  
  364. 10.    Suggestions/Registration
  365.  
  366. Firstly I can be contacted by Email or snail mail.
  367.  
  368. Email (Bugs, sugestions only)
  369.  
  370. u9326383@radon.sys.uea.ac.uk
  371.  
  372. I will have access to this account until at least summer 1996.
  373.  
  374. Snail mail( registration requests, bugs, sugestions)
  375.  
  376.  Mr M D Melton,  
  377.  1 Hawksmoor close,  
  378.  North Hykeham, 
  379.  Lincoln, 
  380.  England,
  381.  LN6 9PN
  382.  
  383. Registration
  384.  
  385. What benifits will registration bring you.  Well appart from making your pocket/wallet slightly lighter and
  386. slimmer :-),  firstly it will bring my eternal gratitude, and secondly the very latest version of this program,
  387. if you have an email address where I could send it to, or send me a self addessed jiffy bag or similar
  388. containing a DSDD floppy.  What do I ask for this program, which has been written in my spare time while
  389. studying for my degree, as a possible method of suplementing my income :->
  390.  
  391. Registration is the huge figure of £5, yes thats all, just 5 GB pounds.  Sorry but I can only accept GB pounds.
  392. This is because the bank would want its huge slice for changing forign currencies :-<.
  393.